/**
 * This file is part of Adaptools.
 * 
 * Adaptools is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Adaptools is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 * along with Adaptools.  If not, see http://www.gnu.org/licenses/. 
 */
package org.adaptools.repository.base;

import java.util.Collection;

import org.adaptools.base.Mechanism;

/**
 * Interface to repository
 * 
 * @author Denys G. Santos (gsdenys@gmail.com)
 * @since 3.0.0
 */
public interface Repository {
	
	/**
	 * Add a new {@link Mechanism} to repository
	 * 
	 * @param mechanism
	 */
	public void addMechanism(Mechanism mechanism);
	
	/**
	 * Remove the {@link Mechanism} from {@link Repository}
	 * @param uuid
	 * @return the removed {@link Mechanism}
	 */
	public boolean remove(String uuid);
	
	/**
	 * gET the {@link Mechanism} from {@link Repository}
	 * @param uuid
	 * @return the {@link Mechanism}
	 */
	public Mechanism get(String uuid);
	
	/**
	 * Get the number of {@link Mechanism} in the {@link Repository}
	 * 
	 * @return the number of {@link Mechanism}
	 */
	public Integer numberOfMechanisms();
	
	/**
	 * Get the helper string. 
	 * 
	 * @return the helper string
	 */
	public String getHelper();
	
	/**
	 * set the helper string. 
	 * 
	 * @param hString
	 */
	public void setHelper(String hString);
	
	/**
	 * Get the semantic script string. 
	 * 
	 * @return the semantic script string
	 */
	public String getSemantic();
	
	/**
	 * set the semantic script string. 
	 * 
	 * @param sString
	 */
	public void setSemantic(String sString);
	
	/**
	 * Get a list of mecheanism
	 * 
	 * @return {@link Collection}
	 */
	public Collection<Mechanism> getAllMechanism();
}